Create a Warehouse Order (B2C)

Below is an example of the recommended information required for a warehouse order. This example is for a customer who has ordered a single unit from an online store.

Example Request

POST /warehouse/v1/orders HTTP/1.1
x-api-key: your_api_key
organization-slug: your_organization_slug (if required)
Content-Type: application/json

{
  "warehouseCode": "LAW",
  "primaryReference": "123456789",
  "secondaryReference": "SO000012345",
  "shipToAddress": {
    "address": {
      "organization": "John Smith",
      "addressLine1": "1234 Main Street",
      "addressLine2": "",
      "country": "USA",
      "state": "CA",
      "city": "Los Angeles",
      "postalCode": "90012"
    },
    "contact": {
      "personName": "John Smith",
      "phoneNumber": "123-456-7890",
      "mobileNumber": "",
      "faxNumber": "",
      "emailAddress": "john.smith@gmail.com"
    }
  },
  "requiredShipDate": "2023-05-15T00:00:00+00:00",
  "orderLines": [
    {
      "externalLineReference": "001",
      "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
      "quantity": 1,
      "quantityUnit": "UNT"
    }
  ],
  "additionalReferences": [
    {
      "key": "ORD",
      "value": "ACME1234"
    }
  ],
  "note": "BEST RATE - FEDEX OR UPS - 2DAY"
}

Replace your_api_key with your actual API key and your_organization_slug with your organization slug, if required.

If the request is successful, you will receive a 200 OK status code and a JSON response containing the newly created warehouse order.

Example Response

{
    "data": {
        "id": "6434c71edd3283f909d1bd54",
        "dateCreated": "2023-04-11T02:34:06+00:00",
        "dateLastUpdated": "2023-04-11T02:34:06+00:00",
        "status": "PRS",
        "warehouseCode": "LAW",
        "primaryReference": "123456789",
        "secondaryReference": "SO000012345",
        "shipToAddress": {
            "address": {
                "organization": "John Smith",
                "addressLine1": "1234 Main Street",
                "addressLine2": "",
                "country": "USA",
                "state": "CA",
                "city": "Los Angeles",
                "postalCode": "90012",
                "isResidential": false
            },
            "contact": {
                "personName": "John Smith",
                "phoneNumber": "123-456-7890",
                "mobileNumber": "",
                "faxNumber": "",
                "emailAddress": "john.smith@gmail.com"
            }
        },
        "requiredShipDate": "2023-05-15T00:00:00+00:00",
        "orderLines": [
            {
                "lineNumber": "1",
                "externalLineReference": "001",
                "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
                "quantity": 1,
                "quantityUnit": "UNT",
                "lineAttributes": [],
                "lineCustomAttributes": [],
                "partAttributes": []
            }
        ],
        "shipments": [
            {
                "id": "6434c720dd3283f909d1bd55",
                "status": "ENT",
                "dateCreated": "2023-04-11T02:34:08+00:00",
                "dateLastUpdated": "2023-04-11T02:34:08+00:00",
                "warehouseCode": "LAW",
                "primaryReference": "123456789",
                "secondaryReference": "SO000012345",
                "shipToAddress": {
                    "address": {
                        "organization": "John Smith",
                        "addressLine1": "1234 Main Street",
                        "addressLine2": "",
                        "country": "USA",
                        "state": "CA",
                        "city": "Los Angeles",
                        "postalCode": "90012",
                        "isResidential": false
                    },
                    "contact": {
                        "personName": "John Smith",
                        "phoneNumber": "123-456-7890",
                        "mobileNumber": "",
                        "faxNumber": "",
                        "emailAddress": "john.smith@gmail.com"
                    }
                },
                "requiredShipDate": "2023-05-15T00:00:00+00:00",
                "packages": [],
                "shipmentLines": [
                    {
                        "sublines": [],
                        "lineNumber": "1",
                        "externalLineReference": "001",
                        "productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
                        "quantity": 1,
                        "quantityUnit": "UNT",
                        "lineAttributes": [],
                        "lineCustomAttributes": [],
                        "partAttributes": []
                    }
                ],
                "milestones": [],
                "additionalReferences": []
            }
        ],
        "additionalReferences": [
            {
                "key": "ORD",
                "value": "ACME1234"
            }
        ],
        "note": "BEST RATE - FEDEX OR UPS - 2DAY"
    },
    "id": "e4181eed70174f29abcf2a7daeb64e66",
    "resource": [],
    "errors": []
}